List Categories

GET /categories

cURL

curl --request GET \
  --url https://api.example.com/categories

200

[
  {
    "id": 1,
    "name": "Teas",
    "slug": "teas",
    "isActive": true,
    "createdAt": "2024-03-10T12:00:00.000Z"
  },
  {
    "id": 2,
    "name": "Pastries",
    "slug": "pastries",
    "isActive": true,
    "createdAt": "2024-03-09T15:30:00.000Z"
  }
]

Retrieves a list of all categories in the system, ordered by creation date (newest first).

Response

data · Category[]

Array of category objects

Show Category object

id · number · required

Unique identifier for the category

name · string · required

Category name

slug · string · required

URL-friendly slug, automatically generated from name

isActive · boolean · required

Whether the category is active

createdAt · string · required

ISO 8601 timestamp of when the category was created

cURL

curl --request GET \
  --url https://api.example.com/categories

200

[
  {
    "id": 1,
    "name": "Teas",
    "slug": "teas",
    "isActive": true,
    "createdAt": "2024-03-10T12:00:00.000Z"
  },
  {
    "id": 2,
    "name": "Pastries",
    "slug": "pastries",
    "isActive": true,
    "createdAt": "2024-03-09T15:30:00.000Z"
  }
]